Vcenter EnvironmentBrowser ConfigOptionDescriptors Summary

Vcenter EnvironmentBrowser ConfigOptionDescriptors Summary
Vcenter EnvironmentBrowser ConfigOptionDescriptors Summary

Contains the definition of a unique key that can be used to retrieve a ConfigOption (vim.vm.ConfigOption) object.

This schema was added in vSphere API 8.0.2.00300.

JSON Example
{
    "config_option": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "hosts": [
        "string"
    ],
    "create_supported": false,
    "default_config_option": false,
    "run_supported": false,
    "upgrade_supported": false
}
string
config_option
Required

A unique key used to identify a ConfigOption object.

This property was added in vSphere API 8.0.2.00300.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.config_option. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.config_option.

description
Optional

A description of the configOption object.

This property was added in vSphere API 8.0.2.00300.

when missing or null

array of string
hosts
Optional

List of hosts to which this descriptor applies. List of hosts is not set when descriptor is returned for a Datacenter.

This property was added in vSphere API 8.0.2.00300.

when missing or null

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

boolean
create_supported
Required

Indicates whether the associated set of configuration options can be used for virtual machine creation on a given host or cluster.

This property was added in vSphere API 8.0.2.00300.

boolean
default_config_option
Required

Indicates whether the associated set of virtual machine configuration options is the default one for a given host or cluster. Latest version is marked as default unless other version is specified via the vim.ComputeResource.ConfigInfo or vim.Datacenter.ConfigInfo defaultHardwareVersionKey.

If this setting is TRUE, virtual machine creates will use the associated set of configuration options, unless a config version is explicitly specified in the vim.vm.ConfigSpec.

This property was added in vSphere API 8.0.2.00300.

boolean
run_supported
Required

Indicates whether the associated set of configuration options can be used to power on a virtual machine on a given host or cluster.

This property was added in vSphere API 8.0.2.00300.

boolean
upgrade_supported
Required

Indicates whether the associated set of configuration options can be used as a virtual hardware upgrade target.

This property was added in vSphere API 8.0.2.00300.

Property Of